<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: src/freertos-addon/c++/include/critical.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_613ab928e2cac05f46a549f1010a006c.html">freertos-addon</a></li><li class="navelem"><a class="el" href="dir_1561b40f2a44bc3fb1e89a4f48d1054f.html">c++</a></li><li class="navelem"><a class="el" href="dir_651d9e330e31228dbb237d3e8c532be3.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">critical.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/****************************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> *</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *  Copyright (c) 2017, Michael Becker (michael.f.becker@gmail.com)</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> *  This file is part of the FreeRTOS Add-ons project.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> *  Source Code:</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *  https://github.com/michaelbecker/freertos-addons</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *  Project Page:</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> *  http://michaelbecker.github.io/freertos-addons/</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> *  On-line Documentation:</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> *  http://michaelbecker.github.io/freertos-addons/docs/html/index.html</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> *  copy of this software and associated documentation files</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> *  (the &quot;Software&quot;), to deal in the Software without restriction, including</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> *  without limitation the rights to use, copy, modify, merge, publish,</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> *  distribute, sublicense, and/or sell copies of the Software, and to</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> *  permit persons to whom the Software is furnished to do so,subject to the</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> *  following conditions:</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> *</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> *  + The above copyright notice and this permission notice shall be included</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> *    in all copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> *  + Credit is appreciated, but not required, if you find this project</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> *    useful enough to include in your application, product, device, etc.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> *</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> *  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> *</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#include &quot;freertos-config.h&quot;</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#ifndef CRITICAL_HPP_</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#define CRITICAL_HPP_</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#include &quot;FreeRTOS.h&quot;</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#include &quot;task.h&quot;</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacecpp__freertos.html">cpp_freertos</a> {</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="keyword">class </span>CriticalSection {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    <span class="comment">//  Public API</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    <span class="comment">//  Available from anywhere.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"></span>    <span class="keyword">public</span>:</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#ac31be583c6674aea582d4fa831e4e3fb">   68</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#ac31be583c6674aea582d4fa831e4e3fb">Enter</a>()</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>        {</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>            taskENTER_CRITICAL();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>        }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#a5f7e9a6a562669d8554658e5e974302a">   76</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#a5f7e9a6a562669d8554658e5e974302a">Exit</a>()</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>        {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>            taskEXIT_CRITICAL();</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>        }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#ab78166fa2e3130eb0285b9ff88bc090a">   92</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> BaseType_t <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#ab78166fa2e3130eb0285b9ff88bc090a">EnterFromISR</a>()</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>        {</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>            <span class="keywordflow">return</span> taskENTER_CRITICAL_FROM_ISR();</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>        }</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#ab3b454d554d41da00bb23c8c32a4b21a">  106</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#ab3b454d554d41da00bb23c8c32a4b21a">ExitFromISR</a>(BaseType_t savedInterruptStatus)</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>        {</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>            taskEXIT_CRITICAL_FROM_ISR(savedInterruptStatus);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>        }</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#a6648fd37c8556b2a8e958011f4614817">  114</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#a6648fd37c8556b2a8e958011f4614817">DisableInterrupts</a>()</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>        {</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>            taskDISABLE_INTERRUPTS();</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>        }</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#ad5052d7f1847b41cc503076be983ff96">  122</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#ad5052d7f1847b41cc503076be983ff96">EnableInterrupts</a>()</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>        {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>            taskENABLE_INTERRUPTS();</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>        }</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#a27aa6c4e9bf5bbe3da7222030392783c">  130</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#a27aa6c4e9bf5bbe3da7222030392783c">SuspendScheduler</a>()</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>        {</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>            vTaskSuspendAll();</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>        }</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classcpp__freertos_1_1_critical_section.html#a33568ab0478ad5fb4e7438af8e25a40d">  138</a></span>        <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcpp__freertos_1_1_critical_section.html#a33568ab0478ad5fb4e7438af8e25a40d">ResumeScheduler</a>()</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>        {</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>            xTaskResumeAll();</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>        }</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>};</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>}</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_a27aa6c4e9bf5bbe3da7222030392783c"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#a27aa6c4e9bf5bbe3da7222030392783c">cpp_freertos::CriticalSection::SuspendScheduler</a></div><div class="ttdeci">static void SuspendScheduler()</div><div class="ttdef"><b>Definition:</b> critical.hpp:130</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_a33568ab0478ad5fb4e7438af8e25a40d"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#a33568ab0478ad5fb4e7438af8e25a40d">cpp_freertos::CriticalSection::ResumeScheduler</a></div><div class="ttdeci">static void ResumeScheduler()</div><div class="ttdef"><b>Definition:</b> critical.hpp:138</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_a5f7e9a6a562669d8554658e5e974302a"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#a5f7e9a6a562669d8554658e5e974302a">cpp_freertos::CriticalSection::Exit</a></div><div class="ttdeci">static void Exit()</div><div class="ttdef"><b>Definition:</b> critical.hpp:76</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_a6648fd37c8556b2a8e958011f4614817"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#a6648fd37c8556b2a8e958011f4614817">cpp_freertos::CriticalSection::DisableInterrupts</a></div><div class="ttdeci">static void DisableInterrupts()</div><div class="ttdef"><b>Definition:</b> critical.hpp:114</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_ab3b454d554d41da00bb23c8c32a4b21a"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#ab3b454d554d41da00bb23c8c32a4b21a">cpp_freertos::CriticalSection::ExitFromISR</a></div><div class="ttdeci">static void ExitFromISR(BaseType_t savedInterruptStatus)</div><div class="ttdef"><b>Definition:</b> critical.hpp:106</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_ab78166fa2e3130eb0285b9ff88bc090a"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#ab78166fa2e3130eb0285b9ff88bc090a">cpp_freertos::CriticalSection::EnterFromISR</a></div><div class="ttdeci">static BaseType_t EnterFromISR()</div><div class="ttdef"><b>Definition:</b> critical.hpp:92</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_ac31be583c6674aea582d4fa831e4e3fb"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#ac31be583c6674aea582d4fa831e4e3fb">cpp_freertos::CriticalSection::Enter</a></div><div class="ttdeci">static void Enter()</div><div class="ttdef"><b>Definition:</b> critical.hpp:68</div></div>
<div class="ttc" id="aclasscpp__freertos_1_1_critical_section_html_ad5052d7f1847b41cc503076be983ff96"><div class="ttname"><a href="classcpp__freertos_1_1_critical_section.html#ad5052d7f1847b41cc503076be983ff96">cpp_freertos::CriticalSection::EnableInterrupts</a></div><div class="ttdeci">static void EnableInterrupts()</div><div class="ttdef"><b>Definition:</b> critical.hpp:122</div></div>
<div class="ttc" id="anamespacecpp__freertos_html"><div class="ttname"><a href="namespacecpp__freertos.html">cpp_freertos</a></div><div class="ttdef"><b>Definition:</b> condition_variable.hpp:57</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
